<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>read</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="random_access_file.html" title="random_access_file">
<link rel="next" href="read/overload1.html" title="read (1 of 16 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="random_access_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.read"></a><a class="link" href="read.html" title="read">read</a>
</h3></div></div></div>
<p>
        <a class="indexterm" name="boost_asio.indexterm.read"></a> 
The <code class="computeroutput">read</code> function is a composed
        operation that reads a certain amount of data from a stream before returning.
      </p>
<p>
        Attempt to read a certain amount of data from a stream before returning.
      </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t <a class="link" href="read/overload1.html" title="read (1 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    const MutableBufferSequence &amp; buffers,
    typename constraint&lt; is_mutable_buffer_sequence&lt; MutableBufferSequence &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload1.html" title="read (1 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t <a class="link" href="read/overload2.html" title="read (2 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    const MutableBufferSequence &amp; buffers,
    boost::system::error_code &amp; ec,
    typename constraint&lt; is_mutable_buffer_sequence&lt; MutableBufferSequence &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload2.html" title="read (2 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
    typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>&gt;
std::size_t <a class="link" href="read/overload3.html" title="read (3 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    const MutableBufferSequence &amp; buffers,
    CompletionCondition completion_condition,
    typename constraint&lt; is_mutable_buffer_sequence&lt; MutableBufferSequence &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload3.html" title="read (3 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
    typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>&gt;
std::size_t <a class="link" href="read/overload4.html" title="read (4 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    const MutableBufferSequence &amp; buffers,
    CompletionCondition completion_condition,
    boost::system::error_code &amp; ec,
    typename constraint&lt; is_mutable_buffer_sequence&lt; MutableBufferSequence &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload4.html" title="read (4 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>&gt;
std::size_t <a class="link" href="read/overload5.html" title="read (5 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    DynamicBuffer_v1 &amp;&amp; buffers,
    typename constraint&lt; is_dynamic_buffer_v1&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type  = 0,
    typename constraint&lt; !is_dynamic_buffer_v2&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload5.html" title="read (5 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>&gt;
std::size_t <a class="link" href="read/overload6.html" title="read (6 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    DynamicBuffer_v1 &amp;&amp; buffers,
    boost::system::error_code &amp; ec,
    typename constraint&lt; is_dynamic_buffer_v1&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type  = 0,
    typename constraint&lt; !is_dynamic_buffer_v2&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload6.html" title="read (6 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>,
    typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>&gt;
std::size_t <a class="link" href="read/overload7.html" title="read (7 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    DynamicBuffer_v1 &amp;&amp; buffers,
    CompletionCondition completion_condition,
    typename constraint&lt; is_dynamic_buffer_v1&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type  = 0,
    typename constraint&lt; !is_dynamic_buffer_v2&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload7.html" title="read (7 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>,
    typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>&gt;
std::size_t <a class="link" href="read/overload8.html" title="read (8 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    DynamicBuffer_v1 &amp;&amp; buffers,
    CompletionCondition completion_condition,
    boost::system::error_code &amp; ec,
    typename constraint&lt; is_dynamic_buffer_v1&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type  = 0,
    typename constraint&lt; !is_dynamic_buffer_v2&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload8.html" title="read (8 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename Allocator&gt;
std::size_t <a class="link" href="read/overload9.html" title="read (9 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    basic_streambuf&lt; Allocator &gt; &amp; b);
  <span class="emphasis"><em>» <a class="link" href="read/overload9.html" title="read (9 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename Allocator&gt;
std::size_t <a class="link" href="read/overload10.html" title="read (10 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    basic_streambuf&lt; Allocator &gt; &amp; b,
    boost::system::error_code &amp; ec);
  <span class="emphasis"><em>» <a class="link" href="read/overload10.html" title="read (10 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename Allocator,
    typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>&gt;
std::size_t <a class="link" href="read/overload11.html" title="read (11 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    basic_streambuf&lt; Allocator &gt; &amp; b,
    CompletionCondition completion_condition);
  <span class="emphasis"><em>» <a class="link" href="read/overload11.html" title="read (11 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename Allocator,
    typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>&gt;
std::size_t <a class="link" href="read/overload12.html" title="read (12 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    basic_streambuf&lt; Allocator &gt; &amp; b,
    CompletionCondition completion_condition,
    boost::system::error_code &amp; ec);
  <span class="emphasis"><em>» <a class="link" href="read/overload12.html" title="read (12 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>&gt;
std::size_t <a class="link" href="read/overload13.html" title="read (13 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    DynamicBuffer_v2 buffers,
    typename constraint&lt; is_dynamic_buffer_v2&lt; DynamicBuffer_v2 &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload13.html" title="read (13 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>&gt;
std::size_t <a class="link" href="read/overload14.html" title="read (14 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    DynamicBuffer_v2 buffers,
    boost::system::error_code &amp; ec,
    typename constraint&lt; is_dynamic_buffer_v2&lt; DynamicBuffer_v2 &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload14.html" title="read (14 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>,
    typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>&gt;
std::size_t <a class="link" href="read/overload15.html" title="read (15 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    DynamicBuffer_v2 buffers,
    CompletionCondition completion_condition,
    typename constraint&lt; is_dynamic_buffer_v2&lt; DynamicBuffer_v2 &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload15.html" title="read (15 of 16 overloads)">more...</a></em></span>

template&lt;
    typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>,
    typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>&gt;
std::size_t <a class="link" href="read/overload16.html" title="read (16 of 16 overloads)">read</a>(
    SyncReadStream &amp; s,
    DynamicBuffer_v2 buffers,
    CompletionCondition completion_condition,
    boost::system::error_code &amp; ec,
    typename constraint&lt; is_dynamic_buffer_v2&lt; DynamicBuffer_v2 &gt;::value &gt;::type  = 0);
  <span class="emphasis"><em>» <a class="link" href="read/overload16.html" title="read (16 of 16 overloads)">more...</a></em></span>
</pre>
<h5>
<a name="boost_asio.reference.read.h0"></a>
        <span class="phrase"><a name="boost_asio.reference.read.requirements"></a></span><a class="link" href="read.html#boost_asio.reference.read.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/read.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher
      M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="random_access_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
